home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / pfmt.z / pfmt
Encoding:
Text File  |  1998-10-20  |  7.9 KB  |  130 lines
  1.  
  2.  
  3.  
  4. ppppffffmmmmtttt((((1111))))                                                                ppppffffmmmmtttt((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _pppp_ffff_mmmm_tttt - display error message in standard format
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      pfmt [-l _l_a_b_e_l_]]]]_[[[[_----_ssss _s_e_v_e_r_i_t_y_]]]]_[[[[_----_gggg _c_a_t_a_l_o_g_::::_m_s_g_i_d_]]]] _f_o_r_m_a_t _[[[[_a_r_g_s_]]]]
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      _pppp_ffff_mmmm_tttt uses _f_o_r_m_a_t for _pppp_rrrr_iiii_nnnn_tttt_ffff style formatting of _a_r_g_s.  _pppp_ffff_mmmm_tttt encapsulates
  16.      the output in the standard error message format and displays it on
  17.      _ssss_tttt_dddd_eeee_rrrr_rrrr.
  18.  
  19.      The following options are available.
  20.  
  21.      _----_llll _l_a_b_e_l    Specify the label string to be displayed with the message
  22.                  (for example, _""""_UUUU_XXXX_::::_cccc_aaaa_tttt_"""").  _l_a_b_e_l is a character string no more
  23.                  than 25 characters in length; it will be automatically
  24.                  suffixed with a colon (_::::).  When unspecified, no label is
  25.                  displayed as part of the message or when the environment
  26.                  variable _NNNN_OOOO_MMMM_SSSS_GGGG_LLLL_AAAA_BBBB_EEEE_LLLL has been set.  Setting the _NNNN_OOOO_MMMM_SSSS_GGGG_LLLL_AAAA_BBBB_EEEE_LLLL to
  27.                  turn off the label portion of the message.  Can be used in
  28.                  conjunction with the _NNNN_OOOO_MMMM_SSSS_GGGG_SSSS_EEEE_VVVV_EEEE_RRRR_IIII_TTTT_YYYY environment variable.
  29.  
  30.      _----_ssss _s_e_v_e_r_i_t_y Specify the severity string to be displayed with the message.
  31.                  Acceptable strings include the standard severities in either
  32.                  their print string (that is, _HHHH_AAAA_LLLL_TTTT, _EEEE_RRRR_RRRR_OOOO_RRRR, _IIII_NNNN_FFFF_OOOO, _WWWW_AAAA_RRRR_NNNN_IIII_NNNN_GGGG, and
  33.                  _""""_TTTT_OOOO _FFFF_IIII_XXXX_"""") or keyword (that is, _hhhh_aaaa_llll_tttt, _eeee_rrrr_rrrr_oooo_rrrr, _iiii_nnnn_ffff_oooo, _wwww_aaaa_rrrr_nnnn, and
  34.                  _aaaa_cccc_tttt_iiii_oooo_nnnn) forms, or any other user-defined string.  A user-
  35.                  defined string will be assigned the integer severity value of
  36.                  5.  The severity will be suffixed with a colon (_::::).  The
  37.                  _EEEE_RRRR_RRRR_OOOO_RRRR severity will be used if no severity is specified,
  38.                  unless the _NNNN_OOOO_MMMM_SSSS_GGGG_SSSS_EEEE_VVVV_EEEE_RRRR_IIII_TTTT_YYYY environment variable has been set.
  39.                  Setting the _NNNN_OOOO_MMMM_SSSS_GGGG_SSSS_EEEE_VVVV_EEEE_RRRR_IIII_TTTT_YYYY to turn off the severity portion of
  40.                  the message.  Can be used in conjunction with the _NNNN_OOOO_MMMM_SSSS_GGGG_LLLL_AAAA_BBBB_EEEE_LLLL
  41.                  environment variable.
  42.  
  43.      _----_gggg _c_a_t_a_l_o_g_::::_m_s_g_i_d
  44.                  Specify that a localized version of _f_o_r_m_a_t should be
  45.                  retrieved from a locale-specific message database.  _c_a_t_a_l_o_g
  46.                  indicates the message database that contains the localized
  47.                  version of the _f_o_r_m_a_t string.  _c_a_t_a_l_o_g must be limited to 14
  48.                  characters.  These characters must be selected from a set of
  49.                  all characters values, excluding _\\\\_0000 (_NNNN_UUUU_LLLL_LLLL) or the characters
  50.                  _//// (slash) and _:::: (colon).
  51.                  _m_s_g_i_d is a positive number that indicates the index of the
  52.                  string into the message database.
  53.                  If _c_a_t_a_l_o_g does not exist in the current locale (identified
  54.                  by the _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS or _LLLL_AAAA_NNNN_GGGG environment variables), or if
  55.                  _m_s_g_i_d is out of bounds, _pppp_ffff_mmmm_tttt will attempt to retrieve the
  56.                  message from the C locale.  If this second retrieval fails,
  57.                  _pppp_ffff_mmmm_tttt uses the _f_o_r_m_a_t string as passed on the command line.
  58.                  _pppp_ffff_mmmm_tttt will output _MMMM_eeee_ssss_ssss_aaaa_gggg_eeee _nnnn_oooo_tttt _ffff_oooo_uuuu_nnnn_dddd_!!!!_!!!!_\\\\_nnnn as the _f_o_r_m_a_t string
  59.  
  60.  
  61.                                                                         PPPPaaaaggggeeee 1111
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. ppppffffmmmmtttt((((1111))))                                                                ppppffffmmmmtttt((((1111))))
  69.  
  70.  
  71.  
  72.                  if _m_s_g_i_d is not a valid number.
  73.  
  74.    SSSSttttaaaannnnddddaaaarrrrdddd EEEErrrrrrrroooorrrr MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt
  75.      _pppp_ffff_mmmm_tttt displays error messages in the following format:
  76.  
  77.           _l_a_b_e_l_:::: _s_e_v_e_r_i_t_y_:::: _t_e_x_t
  78.  
  79.      If no _l_a_b_e_l was defined using the _----_llll _l_a_b_e_l option, the message is
  80.      displayed in the format:
  81.           _s_e_v_e_r_i_t_y_:::: _t_e_x_t
  82.  
  83.      If _pppp_ffff_mmmm_tttt is called twice to display an error message and a helpful _a_c_t_i_o_n
  84.      or recovery message, the output can look like the following:
  85.  
  86.           _l_a_b_e_l_:::: _s_e_v_e_r_i_t_y_:::: _t_e_x_t
  87.           _l_a_b_e_l_:::: _TTTT_OOOO _FFFF_IIII_XXXX_:::: _t_e_x_t
  88.  
  89. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  90.      Example 1:
  91.  
  92.           _pppp_ffff_mmmm_tttt _----_llll _UUUU_XXXX_::::_tttt_eeee_ssss_tttt _----_ssss _eeee_rrrr_rrrr_oooo_rrrr _""""_SSSS_yyyy_nnnn_tttt_aaaa_xxxx _eeee_rrrr_rrrr_oooo_rrrr_\\\\_nnnn_""""
  93.  
  94.      displays the message:
  95.  
  96.           _UUUU_XXXX_::::_tttt_eeee_ssss_tttt_:::: _EEEE_RRRR_RRRR_OOOO_RRRR_:::: _SSSS_yyyy_nnnn_tttt_aaaa_xxxx _eeee_rrrr_rrrr_oooo_rrrr
  97.  
  98. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  99.      _gggg_eeee_tttt_tttt_xxxx_tttt(1), _llll_ffff_mmmm_tttt(1), _pppp_rrrr_iiii_nnnn_tttt_ffff(1), _llll_ffff_mmmm_tttt(3C), _pppp_ffff_mmmm_tttt(3C), _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5)
  100.  
  101. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  102.      Upon success, _pppp_ffff_mmmm_tttt exits with code 0.
  103.  
  104.      Upon failure, _pppp_ffff_mmmm_tttt exits with the following codes:
  105.  
  106.      1    write error
  107.  
  108.      3    syntax error
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.